<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">

<html>
<head>
	<meta http-equiv="content-type" content="text/html; charset=utf-8">
	<link rel="stylesheet" href="css/master.css" type="text/css" media="screen" charset="utf-8">
	<script src="js/jquery.js" type="text/javascript"></script>
	<script src="js/math.js" type="text/javascript"></script>
	<script type="text/javascript" src="js/shCore.js"></script> 
	<script type="text/javascript" src="js/shBrushJScript.js"></script> 
	<script type="text/javascript" src="js/shBrushCpp.js"></script> 
	<script type="text/javascript" src="js/shBrushPython.js"></script> 
	<link type="text/css" rel="stylesheet" href="css/shCoreDefault.css"/> 
	<link type="text/css" rel="stylesheet" href="css/shThemeEclipse.css"/> 
	<script type="text/javascript">SyntaxHighlighter.all();</script>
<title>doc_rule</title>

</head>
<body>
	<div id="header">
		<h1 id="heading">Memory Snippets</h1>
		<div id="sitenav">
			<ul>
				<li><a href="index.html">Home</a></li>
				<li><a href="index.html">Blog</a></li>
				<li><a href="index.html">Wiki</a></li>
				<li><a href="index.html">About</a></li>
			</ul>
		</div>	
	</div>
	<div id="content">
<div id="page">
<h1 id="toc_1">文档书写规范</h1>
<pre>
A: liyiqiang (lyq105@163.com)
T: propose of this document!
C: 2010-12-23 16:59:45
M: 2010-12-23 21:12:26
</pre>
<div class="toc">
<ul>
<li><a href="#toc_1">文档书写规范</a></li>
<ul>
<li><a href="#toc_1.1">需求分析</a></li>
<li><a href="#toc_1.2">文档书写的标准</a></li>
<li><a href="#toc_1.3">文档的书写流程</a></li>
</ul>
</ul>
</div>

<h2 id="toc_1.1">需求分析</h2>
<p>
在我的科研和工作当中要写不少的文档，但是我发现一个问题就是我的文档老是不知所踪，
不知道文档的大致内容，很多项目也常常由于文档不全而使得项目作废，十分的心痛。因此
需要建立一个文档管理，或者说知识管理体系，来管理我的文档。下面分析一下完善的文档
本身所包含的要素，首先是时间问题，创建时间，修改时间(每一次的修改时间都要写出来)，
例如C表示创建时间，用M表示修改时间。文档内容问题，要列书写文档的目的，或者说任务
（TODO）,一条一条地完善。带有目的性地书写文档。
</p>

<h2 id="toc_1.2">文档书写的标准</h2>
<p>
一个文档应该包含两个重要的部分，一个是头部，另一个就是文档的主体。
文档的头部应包含:作者(A),文档创建时间(C),文档的修改时间(M)，和文档的主要目的(P)
文档的主体部分应包含两个部分，一个是索引（或者说是目录），另外就是文档的主要内容。
</p>

<h2 id="toc_1.3">文档的书写流程</h2>
<ol>
<li>
第一次书写文档时要写好文档的头部，确定文档的主要内容，将这些都标注在文档的头部。
</li>
<li>
对于长文档每次修改的时候要标出修改时间。
</li>
<li>
退出文档的修改时要记得标注文档头部的修改时间。
</li>
</ol>
	</div>
	</div>
	<div class="clear"></div>
	<div id="footer">
		© Copyright 2011 @liyiqiang. All Rights Reserved.
	</div>
</body>
</html>
